<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>prd: Overview</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">prd
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__prd.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Overview</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_prd.html">XPrd</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The <a class="el" href="struct_x_prd.html" title="The XPrd instance data structure. ">XPrd</a> instance data structure.  <a href="struct_x_prd.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:gaffb12c25656847672ed8f5cb804467f3"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__prd.html#gaffb12c25656847672ed8f5cb804467f3">XPrd_ReadReg</a>(Address)&#160;&#160;&#160;Xil_In32(Address)</td></tr>
<tr class="memdesc:gaffb12c25656847672ed8f5cb804467f3"><td class="mdescLeft">&#160;</td><td class="mdescRight">This macro reads a value from the given register.  <a href="#gaffb12c25656847672ed8f5cb804467f3">More...</a><br/></td></tr>
<tr class="separator:gaffb12c25656847672ed8f5cb804467f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga93e7e75f1c667dcddcdb0a1a43230415"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__prd.html#ga93e7e75f1c667dcddcdb0a1a43230415">XPrd_WriteReg</a>(Address, Data)&#160;&#160;&#160;Xil_Out32(Address, (u32)(Data))</td></tr>
<tr class="memdesc:ga93e7e75f1c667dcddcdb0a1a43230415"><td class="mdescLeft">&#160;</td><td class="mdescRight">This macro writes a value to the given register.  <a href="#ga93e7e75f1c667dcddcdb0a1a43230415">More...</a><br/></td></tr>
<tr class="separator:ga93e7e75f1c667dcddcdb0a1a43230415"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ga0535d78c352329f7600250c0936ffc21"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__prd.html#ga0535d78c352329f7600250c0936ffc21">XPrd_State</a> { <a class="el" href="group__prd.html#gga0535d78c352329f7600250c0936ffc21ac14eedee45ec9f0d49f1bd9c395177f2">XPRD_DECOUPLER_OFF</a>, 
<a class="el" href="group__prd.html#gga0535d78c352329f7600250c0936ffc21a91d1acd860924ac7a0255af3fd3fbb30">XPRD_DECOUPLER_ON</a>
 }</td></tr>
<tr class="separator:ga0535d78c352329f7600250c0936ffc21"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga424f5c8b2cad657a5aea953ba959be55"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__prd.html#ga424f5c8b2cad657a5aea953ba959be55">XPrd_CfgInitialize</a> (<a class="el" href="struct_x_prd.html">XPrd</a> *InstancePtr, XPrd_Config *ConfigPtr, u32 EffectiveAddress)</td></tr>
<tr class="memdesc:ga424f5c8b2cad657a5aea953ba959be55"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function initializes a <a class="el" href="struct_x_prd.html" title="The XPrd instance data structure. ">XPrd</a> instance/driver.  <a href="#ga424f5c8b2cad657a5aea953ba959be55">More...</a><br/></td></tr>
<tr class="separator:ga424f5c8b2cad657a5aea953ba959be55"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacb64d55940567d71186233e1e230c0d0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__prd.html#gacb64d55940567d71186233e1e230c0d0">XPrd_SetDecouplerState</a> (<a class="el" href="struct_x_prd.html">XPrd</a> *InstancePtr, <a class="el" href="group__prd.html#ga0535d78c352329f7600250c0936ffc21">XPrd_State</a> DecouplerValue)</td></tr>
<tr class="memdesc:gacb64d55940567d71186233e1e230c0d0"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is used to set Decoupler On or Off.  <a href="#gacb64d55940567d71186233e1e230c0d0">More...</a><br/></td></tr>
<tr class="separator:gacb64d55940567d71186233e1e230c0d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad37688cbdb9d0b50c481132f6f05cee0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__prd.html#ga0535d78c352329f7600250c0936ffc21">XPrd_State</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__prd.html#gad37688cbdb9d0b50c481132f6f05cee0">XPrd_GetDecouplerState</a> (<a class="el" href="struct_x_prd.html">XPrd</a> *InstancePtr)</td></tr>
<tr class="memdesc:gad37688cbdb9d0b50c481132f6f05cee0"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is used to read the state of the Decoupler.  <a href="#gad37688cbdb9d0b50c481132f6f05cee0">More...</a><br/></td></tr>
<tr class="separator:gad37688cbdb9d0b50c481132f6f05cee0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7a83aa6940de765c091dfd07df308ac2"><td class="memItemLeft" align="right" valign="top">XPrd_Config *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__prd.html#ga7a83aa6940de765c091dfd07df308ac2">XPrd_LookupConfig</a> (u16 DeviceId)</td></tr>
<tr class="memdesc:ga7a83aa6940de765c091dfd07df308ac2"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function looks for the device configuration based on the unique device ID.  <a href="#ga7a83aa6940de765c091dfd07df308ac2">More...</a><br/></td></tr>
<tr class="separator:ga7a83aa6940de765c091dfd07df308ac2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf18335c2976ab9b7c9d12a5a0c0a450c"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__prd.html#gaf18335c2976ab9b7c9d12a5a0c0a450c">XPrd_SelfTest</a> (<a class="el" href="struct_x_prd.html">XPrd</a> *InstancePtr)</td></tr>
<tr class="memdesc:gaf18335c2976ab9b7c9d12a5a0c0a450c"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function runs a self-test for the PRD driver.  <a href="#gaf18335c2976ab9b7c9d12a5a0c0a450c">More...</a><br/></td></tr>
<tr class="separator:gaf18335c2976ab9b7c9d12a5a0c0a450c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
Register Offset</h2></td></tr>
<tr class="memitem:ga822c5f24e18d6a6b7b1c23cfbf640693"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__prd.html#ga822c5f24e18d6a6b7b1c23cfbf640693">XPRD_CTRL_OFFSET</a>&#160;&#160;&#160;(0x000)</td></tr>
<tr class="memdesc:ga822c5f24e18d6a6b7b1c23cfbf640693"><td class="mdescLeft">&#160;</td><td class="mdescRight">Control register Offset and status register is also mappped to same address as Control register.  <a href="#ga822c5f24e18d6a6b7b1c23cfbf640693">More...</a><br/></td></tr>
<tr class="separator:ga822c5f24e18d6a6b7b1c23cfbf640693"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
Register Mask</h2></td></tr>
<tr class="memitem:ga73f34d1bb856e71aedea43644e2da1db"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__prd.html#ga73f34d1bb856e71aedea43644e2da1db">XPRD_CTRL_DECOUPLER_MASK</a>&#160;&#160;&#160;(0x00000001)</td></tr>
<tr class="memdesc:ga73f34d1bb856e71aedea43644e2da1db"><td class="mdescLeft">&#160;</td><td class="mdescRight">Decoupler Mask.  <a href="#ga73f34d1bb856e71aedea43644e2da1db">More...</a><br/></td></tr>
<tr class="separator:ga73f34d1bb856e71aedea43644e2da1db"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga73f34d1bb856e71aedea43644e2da1db"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XPRD_CTRL_DECOUPLER_MASK&#160;&#160;&#160;(0x00000001)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Decoupler Mask. </p>

<p>Referenced by <a class="el" href="group__prd.html#gad37688cbdb9d0b50c481132f6f05cee0">XPrd_GetDecouplerState()</a>.</p>

</div>
</div>
<a class="anchor" id="ga822c5f24e18d6a6b7b1c23cfbf640693"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XPRD_CTRL_OFFSET&#160;&#160;&#160;(0x000)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Control register Offset and status register is also mappped to same address as Control register. </p>

<p>Referenced by <a class="el" href="group__prd.html#gad37688cbdb9d0b50c481132f6f05cee0">XPrd_GetDecouplerState()</a>, <a class="el" href="group__prd.html#gaf18335c2976ab9b7c9d12a5a0c0a450c">XPrd_SelfTest()</a>, and <a class="el" href="group__prd.html#gacb64d55940567d71186233e1e230c0d0">XPrd_SetDecouplerState()</a>.</p>

</div>
</div>
<a class="anchor" id="gaffb12c25656847672ed8f5cb804467f3"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XPrd_ReadReg</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">Address</td><td>)</td>
          <td>&#160;&#160;&#160;Xil_In32(Address)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This macro reads a value from the given register. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">Address</td><td>is the address of the register to read from.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The 32-bit value read from register.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>Referenced by <a class="el" href="group__prd.html#gad37688cbdb9d0b50c481132f6f05cee0">XPrd_GetDecouplerState()</a>, and <a class="el" href="group__prd.html#gaf18335c2976ab9b7c9d12a5a0c0a450c">XPrd_SelfTest()</a>.</p>

</div>
</div>
<a class="anchor" id="ga93e7e75f1c667dcddcdb0a1a43230415"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XPrd_WriteReg</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">Address, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">Data&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td>&#160;&#160;&#160;Xil_Out32(Address, (u32)(Data))</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This macro writes a value to the given register. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">Address</td><td>is the address of the register to write to. </td></tr>
    <tr><td class="paramname">Data</td><td>is the 32-bit value to write to the register.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>Referenced by <a class="el" href="group__prd.html#gacb64d55940567d71186233e1e230c0d0">XPrd_SetDecouplerState()</a>.</p>

</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="ga0535d78c352329f7600250c0936ffc21"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__prd.html#ga0535d78c352329f7600250c0936ffc21">XPrd_State</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="gga0535d78c352329f7600250c0936ffc21ac14eedee45ec9f0d49f1bd9c395177f2"></a>XPRD_DECOUPLER_OFF</em>&nbsp;</td><td class="fielddoc">
<p>Decoupler Off. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga0535d78c352329f7600250c0936ffc21a91d1acd860924ac7a0255af3fd3fbb30"></a>XPRD_DECOUPLER_ON</em>&nbsp;</td><td class="fielddoc">
<p>Decoupler On. </p>
</td></tr>
</table>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga424f5c8b2cad657a5aea953ba959be55"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">s32 XPrd_CfgInitialize </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_prd.html">XPrd</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">XPrd_Config *&#160;</td>
          <td class="paramname"><em>ConfigPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>EffectiveAddress</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function initializes a <a class="el" href="struct_x_prd.html" title="The XPrd instance data structure. ">XPrd</a> instance/driver. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_prd.html" title="The XPrd instance data structure. ">XPrd</a> instance. </td></tr>
    <tr><td class="paramname">ConfigPtr</td><td>points to the <a class="el" href="struct_x_prd.html" title="The XPrd instance data structure. ">XPrd</a> device configuration structure. </td></tr>
    <tr><td class="paramname">EffectiveAddress</td><td>is the device base address in the virtual memory address space. If the address translation is not used then the physical address is passed.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if initialization was successful.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>
<p>Set some default values for instance data, don't indicate the device is ready to use until everything has been initialized successfully.</p>

<p>References <a class="el" href="struct_x_prd.html#a56436a9e781a4203a9cb2f63c75fff80">XPrd::Config</a>, and <a class="el" href="struct_x_prd.html#ae394be32476d0fb74f270326b8d73743">XPrd::IsReady</a>.</p>

<p>Referenced by <a class="el" href="xprd__example_8c.html#a410824c3df6d31386f454dee2c709dcb">XPrd_Example()</a>, and <a class="el" href="xprd__selftest__example_8c.html#a41b131e4c2597f0aa4d32345925c7064">XPrd_SelfTestExample()</a>.</p>

</div>
</div>
<a class="anchor" id="gad37688cbdb9d0b50c481132f6f05cee0"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__prd.html#ga0535d78c352329f7600250c0936ffc21">XPrd_State</a> XPrd_GetDecouplerState </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_prd.html">XPrd</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function is used to read the state of the Decoupler. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_prd.html" title="The XPrd instance data structure. ">XPrd</a> instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns decoupler state.<ul>
<li>XPRD_DECOUPLER_ON(1) if Decoupler is enabled.</li>
<li>XPRD_DECOUPLER_OFF(0) if Decoupler is disabled.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_prd.html#a56436a9e781a4203a9cb2f63c75fff80">XPrd::Config</a>, <a class="el" href="struct_x_prd.html#ae394be32476d0fb74f270326b8d73743">XPrd::IsReady</a>, <a class="el" href="group__prd.html#ga73f34d1bb856e71aedea43644e2da1db">XPRD_CTRL_DECOUPLER_MASK</a>, <a class="el" href="group__prd.html#ga822c5f24e18d6a6b7b1c23cfbf640693">XPRD_CTRL_OFFSET</a>, <a class="el" href="group__prd.html#gga0535d78c352329f7600250c0936ffc21ac14eedee45ec9f0d49f1bd9c395177f2">XPRD_DECOUPLER_OFF</a>, <a class="el" href="group__prd.html#gga0535d78c352329f7600250c0936ffc21a91d1acd860924ac7a0255af3fd3fbb30">XPRD_DECOUPLER_ON</a>, and <a class="el" href="group__prd.html#gaffb12c25656847672ed8f5cb804467f3">XPrd_ReadReg</a>.</p>

<p>Referenced by <a class="el" href="xprd__example_8c.html#a7d27eeac5a2c92eea613b73500530488">XPrd_TestDecouplerState()</a>.</p>

</div>
</div>
<a class="anchor" id="ga7a83aa6940de765c091dfd07df308ac2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">XPrd_Config * XPrd_LookupConfig </td>
          <td>(</td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>DeviceId</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function looks for the device configuration based on the unique device ID. </p>
<p>The table XPrd_ConfigTable[] contains the configuration information for each device in the system.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">DeviceId</td><td>is the unique device ID of the device being looked up.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A pointer to the configuration table entry corresponding to the given device ID, or NULL if no match is found.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>Referenced by <a class="el" href="xprd__example_8c.html#a410824c3df6d31386f454dee2c709dcb">XPrd_Example()</a>, and <a class="el" href="xprd__selftest__example_8c.html#a41b131e4c2597f0aa4d32345925c7064">XPrd_SelfTestExample()</a>.</p>

</div>
</div>
<a class="anchor" id="gaf18335c2976ab9b7c9d12a5a0c0a450c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">s32 XPrd_SelfTest </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_prd.html">XPrd</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function runs a self-test for the PRD driver. </p>
<p>This self test reads the value from the status register.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_prd.html" title="The XPrd instance data structure. ">XPrd</a> instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if the test was successful.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_prd.html#a56436a9e781a4203a9cb2f63c75fff80">XPrd::Config</a>, <a class="el" href="struct_x_prd.html#ae394be32476d0fb74f270326b8d73743">XPrd::IsReady</a>, <a class="el" href="group__prd.html#ga822c5f24e18d6a6b7b1c23cfbf640693">XPRD_CTRL_OFFSET</a>, and <a class="el" href="group__prd.html#gaffb12c25656847672ed8f5cb804467f3">XPrd_ReadReg</a>.</p>

<p>Referenced by <a class="el" href="xprd__example_8c.html#a410824c3df6d31386f454dee2c709dcb">XPrd_Example()</a>, and <a class="el" href="xprd__selftest__example_8c.html#a41b131e4c2597f0aa4d32345925c7064">XPrd_SelfTestExample()</a>.</p>

</div>
</div>
<a class="anchor" id="gacb64d55940567d71186233e1e230c0d0"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XPrd_SetDecouplerState </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_prd.html">XPrd</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__prd.html#ga0535d78c352329f7600250c0936ffc21">XPrd_State</a>&#160;</td>
          <td class="paramname"><em>DecouplerValue</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function is used to set Decoupler On or Off. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_prd.html" title="The XPrd instance data structure. ">XPrd</a> instance. </td></tr>
    <tr><td class="paramname">DecouplerValue</td><td>is to set Decoupler On or Off. Value can be either 0 or 1. Values are<ul>
<li>XPRD_DECOUPLER_OFF(0) if Decoupler is Off</li>
<li>XPRD_DECOUPLER_ON(1) if Decoupler is On</li>
</ul>
</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None</dd></dl>
<dl class="section note"><dt>Note</dt><dd>When Decoupler is On then it separates the Reconfigurable partition from static logic while Partial Reconfiguration occurs. </dd></dl>

<p>References <a class="el" href="struct_x_prd.html#a56436a9e781a4203a9cb2f63c75fff80">XPrd::Config</a>, <a class="el" href="struct_x_prd.html#ae394be32476d0fb74f270326b8d73743">XPrd::IsReady</a>, <a class="el" href="group__prd.html#ga822c5f24e18d6a6b7b1c23cfbf640693">XPRD_CTRL_OFFSET</a>, <a class="el" href="group__prd.html#gga0535d78c352329f7600250c0936ffc21ac14eedee45ec9f0d49f1bd9c395177f2">XPRD_DECOUPLER_OFF</a>, <a class="el" href="group__prd.html#gga0535d78c352329f7600250c0936ffc21a91d1acd860924ac7a0255af3fd3fbb30">XPRD_DECOUPLER_ON</a>, and <a class="el" href="group__prd.html#ga93e7e75f1c667dcddcdb0a1a43230415">XPrd_WriteReg</a>.</p>

<p>Referenced by <a class="el" href="xprd__example_8c.html#a7d27eeac5a2c92eea613b73500530488">XPrd_TestDecouplerState()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
